/*
 +-----------------------------------------------------------------------------------------------+
 | Project : UKAPI
 +-----------------------------------------------------------------------------------------------+
 | Project Description : Universal & Kernel API
 +-----------------------------------------------------------------------------------------------+
 | File Description :
 |   Stream Driver
 |                                                 
 +-----------------------------------------------------------------------------------------------+
 | Licence : MIT Licence
 +-----------------------------------------------------------------------------------------------+
 | Copyright (c) 2006 Olivier Vanhoucke
 | 
 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
 | and associated documentation files (the "Software"), to deal in the Software without 
 | restriction, including without limitation the rights to use, copy, modify, merge, publish, 
 | distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the 
 | Software is furnished to do so, subject to the following conditions:
 | 
 | The above copyright notice and this permission notice shall be included in all copies or 
 | substantial portions of the Software.
 | 
 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 | BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 | DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 +-----------------------------------------------------------------------------------------------+
*/

#ifndef __UKAPI_KERNEL_STREAM_DRIVER__
#define __UKAPI_KERNEL_STREAM_DRIVER__

#include <private/interrupt.h>
#include <buffer.h>

typedef struct stream_driver_s
{
	char_ascii_t	name[4];
	dword_t			device_number; // auto increment on register ???
	pointer_t		device_context;
	pointer_t		instance_context;
	system_interrupt_t system_interrupt;
	result_t (*init)( struct stream_driver_s * device );		/**< Called on register */
	result_t (*deinit)( struct stream_driver_s * device );		/**< Called on unregister */
	result_t (*open)( struct stream_driver_s * device );
	result_t (*close)( struct stream_driver_s * device );
	result_t (*power_on)( struct stream_driver_s * device );
	result_t (*power_off)( struct stream_driver_s * device );
	result_t (*read)( struct stream_driver_s * device, pbuffer_t pbuffer );
	result_t (*write)( struct stream_driver_s * device, pbuffer_t pbuffer );
	result_t (*seek)( struct stream_driver_s * device );
	result_t (*iocontrol)( struct stream_driver_s * device, pbuffer_t pbuffer_in, pbuffer_t pbuffer_out );
	void (*interrupt_routine)( void );
} stream_driver_t, * pstream_driver_t;

#ifdef __cplusplus
	extern "C" {
#endif /* __cplusplus */

#ifdef __cplusplus
	}
#endif /* __cplusplus */

#endif /* __UKAPI_KERNEL_STREAM_DRIVER__ */
